<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_seq_packet_socket::receive (1 of 3 overloads)</title>
<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../receive.html" title="basic_seq_packet_socket::receive">
<link rel="prev" href="../receive.html" title="basic_seq_packet_socket::receive">
<link rel="next" href="overload2.html" title="basic_seq_packet_socket::receive (2 of 3 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../receive.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../receive.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="boost_asio.reference.basic_seq_packet_socket.receive.overload1"></a><a class="link" href="overload1.html" title="basic_seq_packet_socket::receive (1 of 3 overloads)">basic_seq_packet_socket::receive
          (1 of 3 overloads)</a>
</h5></div></div></div>
<p>
            Receive some data on the socket.
          </p>
<pre class="programlisting">template&lt;
    typename <a class="link" href="../../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>&gt;
std::size_t receive(
    const MutableBufferSequence &amp; buffers,
    socket_base::message_flags &amp; out_flags);
</pre>
<p>
            This function is used to receive data on the sequenced packet socket.
            The function call will block until data has been received successfully,
            or until an error occurs.
          </p>
<h6>
<a name="boost_asio.reference.basic_seq_packet_socket.receive.overload1.h0"></a>
            <span class="phrase"><a name="boost_asio.reference.basic_seq_packet_socket.receive.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_seq_packet_socket.receive.overload1.parameters">Parameters</a>
          </h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">buffers</span></dt>
<dd><p>
                  One or more buffers into which the data will be received.
                </p></dd>
<dt><span class="term">out_flags</span></dt>
<dd><p>
                  After the receive call completes, contains flags associated with
                  the received data. For example, if the <code class="computeroutput">socket_base::message_end_of_record</code>
                  bit is set then the received data marks the end of a record.
                </p></dd>
</dl>
</div>
<h6>
<a name="boost_asio.reference.basic_seq_packet_socket.receive.overload1.h1"></a>
            <span class="phrase"><a name="boost_asio.reference.basic_seq_packet_socket.receive.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_seq_packet_socket.receive.overload1.return_value">Return
            Value</a>
          </h6>
<p>
            The number of bytes received.
          </p>
<h6>
<a name="boost_asio.reference.basic_seq_packet_socket.receive.overload1.h2"></a>
            <span class="phrase"><a name="boost_asio.reference.basic_seq_packet_socket.receive.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_seq_packet_socket.receive.overload1.exceptions">Exceptions</a>
          </h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">boost::system::system_error</span></dt>
<dd><p>
                  Thrown on failure. An error code of <code class="computeroutput">boost::asio::error::eof</code>
                  indicates that the connection was closed by the peer.
                </p></dd>
</dl>
</div>
<h6>
<a name="boost_asio.reference.basic_seq_packet_socket.receive.overload1.h3"></a>
            <span class="phrase"><a name="boost_asio.reference.basic_seq_packet_socket.receive.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_seq_packet_socket.receive.overload1.example">Example</a>
          </h6>
<p>
            To receive into a single data buffer use the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a>
            function as follows:
          </p>
<pre class="programlisting">socket.receive(boost::asio::buffer(data, size), out_flags);
</pre>
<p>
            See the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a>
            documentation for information on receiving into multiple buffers in one
            go, and how to use it with arrays, boost::array or std::vector.
          </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2003-2021 Christopher
      M. Kohlhoff<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../receive.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../receive.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
